home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmCvtXmStringToByteStream.z / XmCvtXmStringToByteStream
Encoding:
Text File  |  2002-10-03  |  4.0 KB  |  67 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTooooBBBByyyytttteeeeSSSSttttrrrreeeeaaaammmm((((3333UUUUXXXXNNNN))))IIIIXXXX SSSSyyyysssstttteeeemmmmXXXXmmmmVVVVCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTooooBBBByyyytttteeeeSSSSttttrrrreeeeaaaammmm((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTooooBBBByyyytttteeeeSSSSttttrrrreeeeaaaammmm - A compound string function that
  10.           converts a compound string to a Byte Stream format
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.           uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTooooBBBByyyytttteeeeSSSSttttrrrreeeeaaaammmm(
  15.           XXXXmmmmSSSSttttrrrriiiinnnngggg ssssttttrrrriiiinnnngggg,
  16.           uuuunnnnssssiiiiggggnnnneeeedddd cccchhhhaaaarrrr ********pppprrrroooopppp____rrrreeeettttuuuurrrrnnnn);
  17.  
  18.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  19.           This page documents Motif 2.1.
  20.  
  21.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  22.           XXXXmmmmCCCCvvvvttttXXXXmmmmSSSSttttrrrriiiinnnnggggTTTTooooBBBByyyytttteeeeSSSSttttrrrreeeeaaaammmm converts a compound string to a
  23.           string of bytes representing the compound string in Byte
  24.           Stream format.  This routine is typically used by the source
  25.           of a data transfer operation to produce a Byte Stream
  26.           representation for transferring a compound string to a
  27.           destination.
  28.  
  29.           If _p_r_o_p__r_e_t_u_r_n is not NULL, this function creates a string
  30.           of characters in Byte Stream format and returns it in
  31.           _p_r_o_p__r_e_t_u_r_n.  The function also returns the number of bytes
  32.           in _p_r_o_p__r_e_t_u_r_n.  If _p_r_o_p__r_e_t_u_r_n is NULL, the function does
  33.           not return the Byte Stream format string, but it does
  34.           calculate and return the number of bytes that would appear
  35.           in the Byte Stream format string.
  36.  
  37.           _s_t_r_i_n_g    Specifies a compound string to be converted to
  38.                     Byte Stream format
  39.  
  40.           _p_r_o_p__r_e_t_u_r_n
  41.                     Specifies a pointer to a string in Byte Stream
  42.                     format that is created and returned by this
  43.                     function.  If _p_r_o_p__r_e_t_u_r_n is NULL, no Byte Stream
  44.                     format string is returned.  When a Byte Stream
  45.                     format string is returned, the function allocates
  46.                     space to hold it.  The application is responsible
  47.                     for managing this allocated space.  The
  48.                     application can recover the allocated space by
  49.                     calling XXXXttttFFFFrrrreeeeeeee.
  50.  
  51.      RRRREEEETTTTUUUURRRRNNNN
  52.           Returns the number of bytes in the Byte Stream
  53.           representation (whether or not the Byte Stream
  54.           representation is returned).
  55.  
  56.      RRRREEEELLLLAAAATTTTEEEEDDDD
  57.           XXXXmmmmSSSSttttrrrriiiinnnngggg(3) and XXXXmmmmCCCCvvvvttttBBBByyyytttteeeeSSSSttttrrrreeeeaaaammmmTTTTooooXXXXmmmmSSSSttttrrrriiiinnnngggg(3).
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.